home *** CD-ROM | disk | FTP | other *** search
/ Languguage OS 2 / Languguage OS II Version 10-94 (Knowledge Media)(1994).ISO / gnu / gcc_260.zip / gcc_260 / gcc.info-22 (.txt) < prev    next >
GNU Info File  |  1994-07-14  |  43KB  |  760 lines

  1. This is Info file gcc.info, produced by Makeinfo-1.54 from the input
  2. file gcc.texi.
  3.    This file documents the use and the internals of the GNU compiler.
  4.    Published by the Free Software Foundation 675 Massachusetts Avenue
  5. Cambridge, MA 02139 USA
  6.    Copyright (C) 1988, 1989, 1992, 1993 Free Software Foundation, Inc.
  7.    Permission is granted to make and distribute verbatim copies of this
  8. manual provided the copyright notice and this permission notice are
  9. preserved on all copies.
  10.    Permission is granted to copy and distribute modified versions of
  11. this manual under the conditions for verbatim copying, provided also
  12. that the sections entitled "GNU General Public License" and "Protect
  13. Your Freedom--Fight `Look And Feel'" are included exactly as in the
  14. original, and provided that the entire resulting derived work is
  15. distributed under the terms of a permission notice identical to this
  16.    Permission is granted to copy and distribute translations of this
  17. manual into another language, under the above conditions for modified
  18. versions, except that the sections entitled "GNU General Public
  19. License" and "Protect Your Freedom--Fight `Look And Feel'", and this
  20. permission notice, may be included in translations approved by the Free
  21. Software Foundation instead of in the original English.
  22. File: gcc.info,  Node: Initialization,  Next: Macros for Initialization,  Prev: Label Output,  Up: Assembler Format
  23. How Initialization Functions Are Handled
  24. ----------------------------------------
  25.    The compiled code for certain languages includes "constructors"
  26. (also called "initialization routines")--functions to initialize data
  27. in the program when the program is started.  These functions need to be
  28. called before the program is "started"--that is to say, before `main'
  29. is called.
  30.    Compiling some languages generates "destructors" (also called
  31. "termination routines") that should be called when the program
  32. terminates.
  33.    To make the initialization and termination functions work, the
  34. compiler must output something in the assembler code to cause those
  35. functions to be called at the appropriate time.  When you port the
  36. compiler to a new system, you need to specify how to do this.
  37.    There are two major ways that GCC currently supports the execution of
  38. initialization and termination functions.  Each way has two variants.
  39. Much of the structure is common to all four variations.
  40.    The linker must build two lists of these functions--a list of
  41. initialization functions, called `__CTOR_LIST__', and a list of
  42. termination functions, called `__DTOR_LIST__'.
  43.    Each list always begins with an ignored function pointer (which may
  44. hold 0, -1, or a count of the function pointers after it, depending on
  45. the environment).  This is followed by a series of zero or more function
  46. pointers to constructors (or destructors), followed by a function
  47. pointer containing zero.
  48.    Depending on the operating system and its executable file format,
  49. either `crtstuff.c' or `libgcc2.c' traverses these lists at startup
  50. time and exit time.  Constructors are called in forward order of the
  51. list; destructors in reverse order.
  52.    The best way to handle static constructors works only for object file
  53. formats which provide arbitrarily-named sections.  A section is set
  54. aside for a list of constructors, and another for a list of destructors.
  55. Traditionally these are called `.ctors' and `.dtors'.  Each object file
  56. that defines an initialization function also puts a word in the
  57. constructor section to point to that function.  The linker accumulates
  58. all these words into one contiguous `.ctors' section.  Termination
  59. functions are handled similarly.
  60.    To use this method, you need appropriate definitions of the macros
  61. `ASM_OUTPUT_CONSTRUCTOR' and `ASM_OUTPUT_DESTRUCTOR'.  Usually you can
  62. get them by including `svr4.h'.
  63.    When arbitrary sections are available, there are two variants,
  64. depending upon how the code in `crtstuff.c' is called.  On systems that
  65. support an "init" section which is executed at program startup, parts
  66. of `crtstuff.c' are compiled into that section.  The program is linked
  67. by the `gcc' driver like this:
  68.      ld -o OUTPUT_FILE crtbegin.o ... crtend.o -lgcc
  69.    The head of a function (`__do_global_ctors') appears in the init
  70. section of `crtbegin.o'; the remainder of the function appears in the
  71. init section of `crtend.o'.  The linker will pull these two parts of
  72. the section together, making a whole function.  If any of the user's
  73. object files linked into the middle of it contribute code, then that
  74. code will be executed as part of the body of `__do_global_ctors'.
  75.    To use this variant, you must define the `INIT_SECTION_ASM_OP' macro
  76. properly.
  77.    If no init section is available, do not define
  78. `INIT_SECTION_ASM_OP'.  Then `__do_global_ctors' is built into the text
  79. section like all other functions, and resides in `libgcc.a'.  When GCC
  80. compiles any function called `main', it inserts a procedure call to
  81. `__main' as the first executable code after the function prologue.  The
  82. `__main' function, also defined in `libgcc2.c', simply calls
  83. `__do_global_ctors'.
  84.    In file formats that don't support arbitrary sections, there are
  85. again two variants.  In the simplest variant, the GNU linker (GNU `ld')
  86. and an `a.out' format must be used.  In this case,
  87. `ASM_OUTPUT_CONSTRUCTOR' is defined to produce a `.stabs' entry of type
  88. `N_SETT', referencing the name `__CTOR_LIST__', and with the address of
  89. the void function containing the initialization code as its value.  The
  90. GNU linker recognizes this as a request to add the value to a "set";
  91. the values are accumulated, and are eventually placed in the executable
  92. as a vector in the format described above, with a leading (ignored)
  93. count and a trailing zero element.  `ASM_OUTPUT_DESTRUCTOR' is handled
  94. similarly.  Since no init section is available, the absence of
  95. `INIT_SECTION_ASM_OP' causes the compilation of `main' to call `__main'
  96. as above, starting the initialization process.
  97.    The last variant uses neither arbitrary sections nor the GNU linker.
  98. This is preferable when you want to do dynamic linking and when using
  99. file formats which the GNU linker does not support, such as `ECOFF'.  In
  100. this case, `ASM_OUTPUT_CONSTRUCTOR' does not produce an `N_SETT'
  101. symbol; initialization and termination functions are recognized simply
  102. by their names.  This requires an extra program in the linkage step,
  103. called `collect2'.  This program pretends to be the linker, for use
  104. with GNU CC; it does its job by running the ordinary linker, but also
  105. arranges to include the vectors of initialization and termination
  106. functions.  These functions are called via `__main' as described above.
  107.    Choosing among these configuration options has been simplified by a
  108. set of operating-system-dependent files in the `config' subdirectory.
  109. These files define all of the relevant parameters.  Usually it is
  110. sufficient to include one into your specific machine-dependent
  111. configuration file.  These files are:
  112. `aoutos.h'
  113.      For operating systems using the `a.out' format.
  114. `next.h'
  115.      For operating systems using the `MachO' format.
  116. `svr3.h'
  117.      For System V Release 3 and similar systems using `COFF' format.
  118. `svr4.h'
  119.      For System V Release 4 and similar systems using `ELF' format.
  120. `vms.h'
  121.      For the VMS operating system.
  122.    The following section describes the specific macros that control and
  123. customize the handling of initialization and termination functions.
  124. File: gcc.info,  Node: Macros for Initialization,  Next: Instruction Output,  Prev: Initialization,  Up: Assembler Format
  125. Macros Controlling Initialization Routines
  126. ------------------------------------------
  127.    Here are the macros that control how the compiler handles
  128. initialization and termination functions:
  129. `INIT_SECTION_ASM_OP'
  130.      If defined, a C string constant for the assembler operation to
  131.      identify the following data as initialization code.  If not
  132.      defined, GNU CC will assume such a section does not exist.  When
  133.      you are using special sections for initialization and termination
  134.      functions, this macro also controls how `crtstuff.c' and
  135.      `libgcc2.c' arrange to run the initialization functions.
  136. `ASM_OUTPUT_CONSTRUCTOR (STREAM, NAME)'
  137.      Define this macro as a C statement to output on the stream STREAM
  138.      the assembler code to arrange to call the function named NAME at
  139.      initialization time.
  140.      Assume that NAME is the name of a C function generated
  141.      automatically by the compiler.  This function takes no arguments.
  142.      Use the function `assemble_name' to output the name NAME; this
  143.      performs any system-specific syntactic transformations such as
  144.      adding an underscore.
  145.      If you don't define this macro, nothing special is output to
  146.      arrange to call the function.  This is correct when the function
  147.      will be called in some other manner--for example, by means of the
  148.      `collect2' program, which looks through the symbol table to find
  149.      these functions by their names.
  150. `ASM_OUTPUT_DESTRUCTOR (STREAM, NAME)'
  151.      This is like `ASM_OUTPUT_CONSTRUCTOR' but used for termination
  152.      functions rather than initialization functions.
  153.    If your system uses `collect2' as the means of processing
  154. constructors, then that program normally uses `nm' to scan an object
  155. file for constructor functions to be called.  On certain kinds of
  156. systems, you can define these macros to make `collect2' work faster
  157. (and, in some cases, make it work at all):
  158. `OBJECT_FORMAT_COFF'
  159.      Define this macro if the system uses COFF (Common Object File
  160.      Format) object files, so that `collect2' can assume this format
  161.      and scan object files directly for dynamic constructor/destructor
  162.      functions.
  163. `OBJECT_FORMAT_ROSE'
  164.      Define this macro if the system uses ROSE format object files, so
  165.      that `collect2' can assume this format and scan object files
  166.      directly for dynamic constructor/destructor functions.
  167.    These macros are effective only in a native compiler; `collect2' as
  168. part of a cross compiler always uses `nm'.
  169. `REAL_NM_FILE_NAME'
  170.      Define this macro as a C string constant containing the file name
  171.      to use to execute `nm'.  The default is to search the path
  172.      normally for `nm'.
  173. File: gcc.info,  Node: Instruction Output,  Next: Dispatch Tables,  Prev: Macros for Initialization,  Up: Assembler Format
  174. Output of Assembler Instructions
  175. --------------------------------
  176. `REGISTER_NAMES'
  177.      A C initializer containing the assembler's names for the machine
  178.      registers, each one as a C string constant.  This is what
  179.      translates register numbers in the compiler into assembler
  180.      language.
  181. `ADDITIONAL_REGISTER_NAMES'
  182.      If defined, a C initializer for an array of structures containing
  183.      a name and a register number.  This macro defines additional names
  184.      for hard registers, thus allowing the `asm' option in declarations
  185.      to refer to registers using alternate names.
  186. `ASM_OUTPUT_OPCODE (STREAM, PTR)'
  187.      Define this macro if you are using an unusual assembler that
  188.      requires different names for the machine instructions.
  189.      The definition is a C statement or statements which output an
  190.      assembler instruction opcode to the stdio stream STREAM.  The
  191.      macro-operand PTR is a variable of type `char *' which points to
  192.      the opcode name in its "internal" form--the form that is written
  193.      in the machine description.  The definition should output the
  194.      opcode name to STREAM, performing any translation you desire, and
  195.      increment the variable PTR to point at the end of the opcode so
  196.      that it will not be output twice.
  197.      In fact, your macro definition may process less than the entire
  198.      opcode name, or more than the opcode name; but if you want to
  199.      process text that includes `%'-sequences to substitute operands,
  200.      you must take care of the substitution yourself.  Just be sure to
  201.      increment PTR over whatever text should not be output normally.
  202.      If you need to look at the operand values, they can be found as the
  203.      elements of `recog_operand'.
  204.      If the macro definition does nothing, the instruction is output in
  205.      the usual way.
  206. `FINAL_PRESCAN_INSN (INSN, OPVEC, NOPERANDS)'
  207.      If defined, a C statement to be executed just prior to the output
  208.      of assembler code for INSN, to modify the extracted operands so
  209.      they will be output differently.
  210.      Here the argument OPVEC is the vector containing the operands
  211.      extracted from INSN, and NOPERANDS is the number of elements of
  212.      the vector which contain meaningful data for this insn.  The
  213.      contents of this vector are what will be used to convert the insn
  214.      template into assembler code, so you can change the assembler
  215.      output by changing the contents of the vector.
  216.      This macro is useful when various assembler syntaxes share a single
  217.      file of instruction patterns; by defining this macro differently,
  218.      you can cause a large class of instructions to be output
  219.      differently (such as with rearranged operands).  Naturally,
  220.      variations in assembler syntax affecting individual insn patterns
  221.      ought to be handled by writing conditional output routines in
  222.      those patterns.
  223.      If this macro is not defined, it is equivalent to a null statement.
  224. `PRINT_OPERAND (STREAM, X, CODE)'
  225.      A C compound statement to output to stdio stream STREAM the
  226.      assembler syntax for an instruction operand X.  X is an RTL
  227.      expression.
  228.      CODE is a value that can be used to specify one of several ways of
  229.      printing the operand.  It is used when identical operands must be
  230.      printed differently depending on the context.  CODE comes from the
  231.      `%' specification that was used to request printing of the
  232.      operand.  If the specification was just `%DIGIT' then CODE is 0;
  233.      if the specification was `%LTR DIGIT' then CODE is the ASCII code
  234.      for LTR.
  235.      If X is a register, this macro should print the register's name.
  236.      The names can be found in an array `reg_names' whose type is `char
  237.      *[]'.  `reg_names' is initialized from `REGISTER_NAMES'.
  238.      When the machine description has a specification `%PUNCT' (a `%'
  239.      followed by a punctuation character), this macro is called with a
  240.      null pointer for X and the punctuation character for CODE.
  241. `PRINT_OPERAND_PUNCT_VALID_P (CODE)'
  242.      A C expression which evaluates to true if CODE is a valid
  243.      punctuation character for use in the `PRINT_OPERAND' macro.  If
  244.      `PRINT_OPERAND_PUNCT_VALID_P' is not defined, it means that no
  245.      punctuation characters (except for the standard one, `%') are used
  246.      in this way.
  247. `PRINT_OPERAND_ADDRESS (STREAM, X)'
  248.      A C compound statement to output to stdio stream STREAM the
  249.      assembler syntax for an instruction operand that is a memory
  250.      reference whose address is X.  X is an RTL expression.
  251.      On some machines, the syntax for a symbolic address depends on the
  252.      section that the address refers to.  On these machines, define the
  253.      macro `ENCODE_SECTION_INFO' to store the information into the
  254.      `symbol_ref', and then check for it here.  *Note Assembler
  255.      Format::.
  256. `DBR_OUTPUT_SEQEND(FILE)'
  257.      A C statement, to be executed after all slot-filler instructions
  258.      have been output.  If necessary, call `dbr_sequence_length' to
  259.      determine the number of slots filled in a sequence (zero if not
  260.      currently outputting a sequence), to decide how many no-ops to
  261.      output, or whatever.
  262.      Don't define this macro if it has nothing to do, but it is helpful
  263.      in reading assembly output if the extent of the delay sequence is
  264.      made explicit (e.g. with white space).
  265.      Note that output routines for instructions with delay slots must be
  266.      prepared to deal with not being output as part of a sequence (i.e.
  267.      when the scheduling pass is not run, or when no slot fillers could
  268.      be found.)  The variable `final_sequence' is null when not
  269.      processing a sequence, otherwise it contains the `sequence' rtx
  270.      being output.
  271. `REGISTER_PREFIX'
  272. `LOCAL_LABEL_PREFIX'
  273. `USER_LABEL_PREFIX'
  274. `IMMEDIATE_PREFIX'
  275.      If defined, C string expressions to be used for the `%R', `%L',
  276.      `%U', and `%I' options of `asm_fprintf' (see `final.c').  These
  277.      are useful when a single `md' file must support multiple assembler
  278.      formats.  In that case, the various `tm.h' files can define these
  279.      macros differently.
  280. `ASSEMBLER_DIALECT'
  281.      If your target supports multiple dialects of assembler language
  282.      (such as different opcodes), define this macro as a C expression
  283.      that gives the numeric index of the assembler langauge dialect to
  284.      use, with zero as the first variant.
  285.      If this macro is defined, you may use
  286.      `{option0|option1|option2...}' constructs in the output templates
  287.      of patterns (*note Output Template::.) or in the first argument of
  288.      `asm_fprintf'.  This construct outputs `option0', `option1' or
  289.      `option2', etc., if the value of `ASSEMBLER_DIALECT' is zero, one
  290.      or two, etc.  Any special characters within these strings retain
  291.      their usual meaning.
  292.      If you do not define this macro, the characters `{', `|' and `}'
  293.      do not have any special meaning when used in templates or operands
  294.      to `asm_fprintf'.
  295.      Define the macros `REGISTER_PREFIX', `LOCAL_LABEL_PREFIX',
  296.      `USER_LABEL_PREFIX' and `IMMEDIATE_PREFIX' if you can express the
  297.      variations in assemble language syntax with that mechanism.  Define
  298.      `ASSEMBLER_DIALECT' and use the `{option0|option1}' syntax if the
  299.      syntax variant are larger and involve such things as different
  300.      opcodes or operand order.
  301. `ASM_OUTPUT_REG_PUSH (STREAM, REGNO)'
  302.      A C expression to output to STREAM some assembler code which will
  303.      push hard register number REGNO onto the stack.  The code need not
  304.      be optimal, since this macro is used only when profiling.
  305. `ASM_OUTPUT_REG_POP (STREAM, REGNO)'
  306.      A C expression to output to STREAM some assembler code which will
  307.      pop hard register number REGNO off of the stack.  The code need
  308.      not be optimal, since this macro is used only when profiling.
  309. File: gcc.info,  Node: Dispatch Tables,  Next: Alignment Output,  Prev: Instruction Output,  Up: Assembler Format
  310. Output of Dispatch Tables
  311. -------------------------
  312. `ASM_OUTPUT_ADDR_DIFF_ELT (STREAM, VALUE, REL)'
  313.      This macro should be provided on machines where the addresses in a
  314.      dispatch table are relative to the table's own address.
  315.      The definition should be a C statement to output to the stdio
  316.      stream STREAM an assembler pseudo-instruction to generate a
  317.      difference between two labels.  VALUE and REL are the numbers of
  318.      two internal labels.  The definitions of these labels are output
  319.      using `ASM_OUTPUT_INTERNAL_LABEL', and they must be printed in the
  320.      same way here.  For example,
  321.           fprintf (STREAM, "\t.word L%d-L%d\n",
  322.                    VALUE, REL)
  323. `ASM_OUTPUT_ADDR_VEC_ELT (STREAM, VALUE)'
  324.      This macro should be provided on machines where the addresses in a
  325.      dispatch table are absolute.
  326.      The definition should be a C statement to output to the stdio
  327.      stream STREAM an assembler pseudo-instruction to generate a
  328.      reference to a label.  VALUE is the number of an internal label
  329.      whose definition is output using `ASM_OUTPUT_INTERNAL_LABEL'.  For
  330.      example,
  331.           fprintf (STREAM, "\t.word L%d\n", VALUE)
  332. `ASM_OUTPUT_CASE_LABEL (STREAM, PREFIX, NUM, TABLE)'
  333.      Define this if the label before a jump-table needs to be output
  334.      specially.  The first three arguments are the same as for
  335.      `ASM_OUTPUT_INTERNAL_LABEL'; the fourth argument is the jump-table
  336.      which follows (a `jump_insn' containing an `addr_vec' or
  337.      `addr_diff_vec').
  338.      This feature is used on system V to output a `swbeg' statement for
  339.      the table.
  340.      If this macro is not defined, these labels are output with
  341.      `ASM_OUTPUT_INTERNAL_LABEL'.
  342. `ASM_OUTPUT_CASE_END (STREAM, NUM, TABLE)'
  343.      Define this if something special must be output at the end of a
  344.      jump-table.  The definition should be a C statement to be executed
  345.      after the assembler code for the table is written.  It should write
  346.      the appropriate code to stdio stream STREAM.  The argument TABLE
  347.      is the jump-table insn, and NUM is the label-number of the
  348.      preceding label.
  349.      If this macro is not defined, nothing special is output at the end
  350.      of the jump-table.
  351. File: gcc.info,  Node: Alignment Output,  Prev: Dispatch Tables,  Up: Assembler Format
  352. Assembler Commands for Alignment
  353. --------------------------------
  354. `ASM_OUTPUT_ALIGN_CODE (FILE)'
  355.      A C expression to output text to align the location counter in the
  356.      way that is desirable at a point in the code that is reached only
  357.      by jumping.
  358.      This macro need not be defined if you don't want any special
  359.      alignment to be done at such a time.  Most machine descriptions do
  360.      not currently define the macro.
  361. `ASM_OUTPUT_LOOP_ALIGN (FILE)'
  362.      A C expression to output text to align the location counter in the
  363.      way that is desirable at the beginning of a loop.
  364.      This macro need not be defined if you don't want any special
  365.      alignment to be done at such a time.  Most machine descriptions do
  366.      not currently define the macro.
  367. `ASM_OUTPUT_SKIP (STREAM, NBYTES)'
  368.      A C statement to output to the stdio stream STREAM an assembler
  369.      instruction to advance the location counter by NBYTES bytes.
  370.      Those bytes should be zero when loaded.  NBYTES will be a C
  371.      expression of type `int'.
  372. `ASM_NO_SKIP_IN_TEXT'
  373.      Define this macro if `ASM_OUTPUT_SKIP' should not be used in the
  374.      text section because it fails put zeros in the bytes that are
  375.      skipped.  This is true on many Unix systems, where the pseudo-op
  376.      to skip bytes produces no-op instructions rather than zeros when
  377.      used in the text section.
  378. `ASM_OUTPUT_ALIGN (STREAM, POWER)'
  379.      A C statement to output to the stdio stream STREAM an assembler
  380.      command to advance the location counter to a multiple of 2 to the
  381.      POWER bytes.  POWER will be a C expression of type `int'.
  382. File: gcc.info,  Node: Debugging Info,  Next: Cross-compilation,  Prev: Assembler Format,  Up: Target Macros
  383. Controlling Debugging Information Format
  384. ========================================
  385. * Menu:
  386. * All Debuggers::      Macros that affect all debugging formats uniformly.
  387. * DBX Options::        Macros enabling specific options in DBX format.
  388. * DBX Hooks::          Hook macros for varying DBX format.
  389. * File Names and DBX:: Macros controlling output of file names in DBX format.
  390. * SDB and DWARF::      Macros for SDB (COFF) and DWARF formats.
  391. File: gcc.info,  Node: All Debuggers,  Next: DBX Options,  Up: Debugging Info
  392. Macros Affecting All Debugging Formats
  393. --------------------------------------
  394. `DBX_REGISTER_NUMBER (REGNO)'
  395.      A C expression that returns the DBX register number for the
  396.      compiler register number REGNO.  In simple cases, the value of this
  397.      expression may be REGNO itself.  But sometimes there are some
  398.      registers that the compiler knows about and DBX does not, or vice
  399.      versa.  In such cases, some register may need to have one number in
  400.      the compiler and another for DBX.
  401.      If two registers have consecutive numbers inside GNU CC, and they
  402.      can be used as a pair to hold a multiword value, then they *must*
  403.      have consecutive numbers after renumbering with
  404.      `DBX_REGISTER_NUMBER'.  Otherwise, debuggers will be unable to
  405.      access such a pair, because they expect register pairs to be
  406.      consecutive in their own numbering scheme.
  407.      If you find yourself defining `DBX_REGISTER_NUMBER' in way that
  408.      does not preserve register pairs, then what you must do instead is
  409.      redefine the actual register numbering scheme.
  410. `DEBUGGER_AUTO_OFFSET (X)'
  411.      A C expression that returns the integer offset value for an
  412.      automatic variable having address X (an RTL expression).  The
  413.      default computation assumes that X is based on the frame-pointer
  414.      and gives the offset from the frame-pointer.  This is required for
  415.      targets that produce debugging output for DBX or COFF-style
  416.      debugging output for SDB and allow the frame-pointer to be
  417.      eliminated when the `-g' options is used.
  418. `DEBUGGER_ARG_OFFSET (OFFSET, X)'
  419.      A C expression that returns the integer offset value for an
  420.      argument having address X (an RTL expression).  The nominal offset
  421.      is OFFSET.
  422. `PREFERRED_DEBUGGING_TYPE'
  423.      A C expression that returns the type of debugging output GNU CC
  424.      produces when the user specifies `-g' or `-ggdb'.  Define this if
  425.      you have arranged for GNU CC to support more than one format of
  426.      debugging output.  Currently, the allowable values are `DBX_DEBUG',
  427.      `SDB_DEBUG', `DWARF_DEBUG', and `XCOFF_DEBUG'.
  428.      The value of this macro only affects the default debugging output;
  429.      the user can always get a specific type of output by using
  430.      `-gstabs', `-gcoff', `-gdwarf', or `-gxcoff'.
  431. File: gcc.info,  Node: DBX Options,  Next: DBX Hooks,  Prev: All Debuggers,  Up: Debugging Info
  432. Specific Options for DBX Output
  433. -------------------------------
  434. `DBX_DEBUGGING_INFO'
  435.      Define this macro if GNU CC should produce debugging output for DBX
  436.      in response to the `-g' option.
  437. `XCOFF_DEBUGGING_INFO'
  438.      Define this macro if GNU CC should produce XCOFF format debugging
  439.      output in response to the `-g' option.  This is a variant of DBX
  440.      format.
  441. `DEFAULT_GDB_EXTENSIONS'
  442.      Define this macro to control whether GNU CC should by default
  443.      generate GDB's extended version of DBX debugging information
  444.      (assuming DBX-format debugging information is enabled at all).  If
  445.      you don't define the macro, the default is 1: always generate the
  446.      extended information if there is any occasion to.
  447. `DEBUG_SYMS_TEXT'
  448.      Define this macro if all `.stabs' commands should be output while
  449.      in the text section.
  450. `ASM_STABS_OP'
  451.      A C string constant naming the assembler pseudo op to use instead
  452.      of `.stabs' to define an ordinary debugging symbol.  If you don't
  453.      define this macro, `.stabs' is used.  This macro applies only to
  454.      DBX debugging information format.
  455. `ASM_STABD_OP'
  456.      A C string constant naming the assembler pseudo op to use instead
  457.      of `.stabd' to define a debugging symbol whose value is the current
  458.      location.  If you don't define this macro, `.stabd' is used.  This
  459.      macro applies only to DBX debugging information format.
  460. `ASM_STABN_OP'
  461.      A C string constant naming the assembler pseudo op to use instead
  462.      of `.stabn' to define a debugging symbol with no name.  If you
  463.      don't define this macro, `.stabn' is used.  This macro applies
  464.      only to DBX debugging information format.
  465. `DBX_NO_XREFS'
  466.      Define this macro if DBX on your system does not support the
  467.      construct `xsTAGNAME'.  On some systems, this construct is used to
  468.      describe a forward reference to a structure named TAGNAME.  On
  469.      other systems, this construct is not supported at all.
  470. `DBX_CONTIN_LENGTH'
  471.      A symbol name in DBX-format debugging information is normally
  472.      continued (split into two separate `.stabs' directives) when it
  473.      exceeds a certain length (by default, 80 characters).  On some
  474.      operating systems, DBX requires this splitting; on others,
  475.      splitting must not be done.  You can inhibit splitting by defining
  476.      this macro with the value zero.  You can override the default
  477.      splitting-length by defining this macro as an expression for the
  478.      length you desire.
  479. `DBX_CONTIN_CHAR'
  480.      Normally continuation is indicated by adding a `\' character to
  481.      the end of a `.stabs' string when a continuation follows.  To use
  482.      a different character instead, define this macro as a character
  483.      constant for the character you want to use.  Do not define this
  484.      macro if backslash is correct for your system.
  485. `DBX_STATIC_STAB_DATA_SECTION'
  486.      Define this macro if it is necessary to go to the data section
  487.      before outputting the `.stabs' pseudo-op for a non-global static
  488.      variable.
  489. `DBX_TYPE_DECL_STABS_CODE'
  490.      The value to use in the "code" field of the `.stabs' directive for
  491.      a typedef.  The default is `N_LSYM'.
  492. `DBX_STATIC_CONST_VAR_CODE'
  493.      The value to use in the "code" field of the `.stabs' directive for
  494.      a static variable located in the text section.  DBX format does not
  495.      provide any "right" way to do this.  The default is `N_FUN'.
  496. `DBX_REGPARM_STABS_CODE'
  497.      The value to use in the "code" field of the `.stabs' directive for
  498.      a parameter passed in registers.  DBX format does not provide any
  499.      "right" way to do this.  The default is `N_RSYM'.
  500. `DBX_REGPARM_STABS_LETTER'
  501.      The letter to use in DBX symbol data to identify a symbol as a
  502.      parameter passed in registers.  DBX format does not customarily
  503.      provide any way to do this.  The default is `'P''.
  504. `DBX_MEMPARM_STABS_LETTER'
  505.      The letter to use in DBX symbol data to identify a symbol as a
  506.      stack parameter.  The default is `'p''.
  507. `DBX_FUNCTION_FIRST'
  508.      Define this macro if the DBX information for a function and its
  509.      arguments should precede the assembler code for the function.
  510.      Normally, in DBX format, the debugging information entirely
  511.      follows the assembler code.
  512. `DBX_LBRAC_FIRST'
  513.      Define this macro if the `N_LBRAC' symbol for a block should
  514.      precede the debugging information for variables and functions
  515.      defined in that block.  Normally, in DBX format, the `N_LBRAC'
  516.      symbol comes first.
  517. File: gcc.info,  Node: DBX Hooks,  Next: File Names and DBX,  Prev: DBX Options,  Up: Debugging Info
  518. Open-Ended Hooks for DBX Format
  519. -------------------------------
  520. `DBX_OUTPUT_LBRAC (STREAM, NAME)'
  521.      Define this macro to say how to output to STREAM the debugging
  522.      information for the start of a scope level for variable names.  The
  523.      argument NAME is the name of an assembler symbol (for use with
  524.      `assemble_name') whose value is the address where the scope begins.
  525. `DBX_OUTPUT_RBRAC (STREAM, NAME)'
  526.      Like `DBX_OUTPUT_LBRAC', but for the end of a scope level.
  527. `DBX_OUTPUT_ENUM (STREAM, TYPE)'
  528.      Define this macro if the target machine requires special handling
  529.      to output an enumeration type.  The definition should be a C
  530.      statement (sans semicolon) to output the appropriate information
  531.      to STREAM for the type TYPE.
  532. `DBX_OUTPUT_FUNCTION_END (STREAM, FUNCTION)'
  533.      Define this macro if the target machine requires special output at
  534.      the end of the debugging information for a function.  The
  535.      definition should be a C statement (sans semicolon) to output the
  536.      appropriate information to STREAM.  FUNCTION is the
  537.      `FUNCTION_DECL' node for the function.
  538. `DBX_OUTPUT_STANDARD_TYPES (SYMS)'
  539.      Define this macro if you need to control the order of output of the
  540.      standard data types at the beginning of compilation.  The argument
  541.      SYMS is a `tree' which is a chain of all the predefined global
  542.      symbols, including names of data types.
  543.      Normally, DBX output starts with definitions of the types for
  544.      integers and characters, followed by all the other predefined
  545.      types of the particular language in no particular order.
  546.      On some machines, it is necessary to output different particular
  547.      types first.  To do this, define `DBX_OUTPUT_STANDARD_TYPES' to
  548.      output those symbols in the necessary order.  Any predefined types
  549.      that you don't explicitly output will be output afterward in no
  550.      particular order.
  551.      Be careful not to define this macro so that it works only for C.
  552.      There are no global variables to access most of the built-in
  553.      types, because another language may have another set of types.
  554.      The way to output a particular type is to look through SYMS to see
  555.      if you can find it.  Here is an example:
  556.           {
  557.             tree decl;
  558.             for (decl = syms; decl; decl = TREE_CHAIN (decl))
  559.               if (!strcmp (IDENTIFIER_POINTER (DECL_NAME (decl)),
  560.                            "long int"))
  561.                 dbxout_symbol (decl);
  562.             ...
  563.           }
  564.      This does nothing if the expected type does not exist.
  565.      See the function `init_decl_processing' in `c-decl.c' to find the
  566.      names to use for all the built-in C types.
  567.      Here is another way of finding a particular type:
  568.           {
  569.             tree decl;
  570.             for (decl = syms; decl; decl = TREE_CHAIN (decl))
  571.               if (TREE_CODE (decl) == TYPE_DECL
  572.                   && (TREE_CODE (TREE_TYPE (decl))
  573.                       == INTEGER_CST)
  574.                   && TYPE_PRECISION (TREE_TYPE (decl)) == 16
  575.                   && TYPE_UNSIGNED (TREE_TYPE (decl)))
  576.           /* This must be `unsigned short'.  */
  577.                 dbxout_symbol (decl);
  578.             ...
  579.           }
  580. File: gcc.info,  Node: File Names and DBX,  Next: SDB and DWARF,  Prev: DBX Hooks,  Up: Debugging Info
  581. File Names in DBX Format
  582. ------------------------
  583. `DBX_WORKING_DIRECTORY'
  584.      Define this if DBX wants to have the current directory recorded in
  585.      each object file.
  586.      Note that the working directory is always recorded if GDB
  587.      extensions are enabled.
  588. `DBX_OUTPUT_MAIN_SOURCE_FILENAME (STREAM, NAME)'
  589.      A C statement to output DBX debugging information to the stdio
  590.      stream STREAM which indicates that file NAME is the main source
  591.      file--the file specified as the input file for compilation.  This
  592.      macro is called only once, at the beginning of compilation.
  593.      This macro need not be defined if the standard form of output for
  594.      DBX debugging information is appropriate.
  595. `DBX_OUTPUT_MAIN_SOURCE_DIRECTORY (STREAM, NAME)'
  596.      A C statement to output DBX debugging information to the stdio
  597.      stream STREAM which indicates that the current directory during
  598.      compilation is named NAME.
  599.      This macro need not be defined if the standard form of output for
  600.      DBX debugging information is appropriate.
  601. `DBX_OUTPUT_MAIN_SOURCE_FILE_END (STREAM, NAME)'
  602.      A C statement to output DBX debugging information at the end of
  603.      compilation of the main source file NAME.
  604.      If you don't define this macro, nothing special is output at the
  605.      end of compilation, which is correct for most machines.
  606. `DBX_OUTPUT_SOURCE_FILENAME (STREAM, NAME)'
  607.      A C statement to output DBX debugging information to the stdio
  608.      stream STREAM which indicates that file NAME is the current source
  609.      file.  This output is generated each time input shifts to a
  610.      different source file as a result of `#include', the end of an
  611.      included file, or a `#line' command.
  612.      This macro need not be defined if the standard form of output for
  613.      DBX debugging information is appropriate.
  614. File: gcc.info,  Node: SDB and DWARF,  Prev: File Names and DBX,  Up: Debugging Info
  615. Macros for SDB and DWARF Output
  616. -------------------------------
  617. `SDB_DEBUGGING_INFO'
  618.      Define this macro if GNU CC should produce COFF-style debugging
  619.      output for SDB in response to the `-g' option.
  620. `DWARF_DEBUGGING_INFO'
  621.      Define this macro if GNU CC should produce dwarf format debugging
  622.      output in response to the `-g' option.
  623. `PUT_SDB_...'
  624.      Define these macros to override the assembler syntax for the
  625.      special SDB assembler directives.  See `sdbout.c' for a list of
  626.      these macros and their arguments.  If the standard syntax is used,
  627.      you need not define them yourself.
  628. `SDB_DELIM'
  629.      Some assemblers do not support a semicolon as a delimiter, even
  630.      between SDB assembler directives.  In that case, define this macro
  631.      to be the delimiter to use (usually `\n').  It is not necessary to
  632.      define a new set of `PUT_SDB_OP' macros if this is the only change
  633.      required.
  634. `SDB_GENERATE_FAKE'
  635.      Define this macro to override the usual method of constructing a
  636.      dummy name for anonymous structure and union types.  See
  637.      `sdbout.c' for more information.
  638. `SDB_ALLOW_UNKNOWN_REFERENCES'
  639.      Define this macro to allow references to unknown structure, union,
  640.      or enumeration tags to be emitted.  Standard COFF does not allow
  641.      handling of unknown references, MIPS ECOFF has support for it.
  642. `SDB_ALLOW_FORWARD_REFERENCES'
  643.      Define this macro to allow references to structure, union, or
  644.      enumeration tags that have not yet been seen to be handled.  Some
  645.      assemblers choke if forward tags are used, while some require it.
  646. File: gcc.info,  Node: Cross-compilation,  Next: Misc,  Prev: Debugging Info,  Up: Target Macros
  647. Cross Compilation and Floating Point
  648. ====================================
  649.    While all modern machines use 2's complement representation for
  650. integers, there are a variety of representations for floating point
  651. numbers.  This means that in a cross-compiler the representation of
  652. floating point numbers in the compiled program may be different from
  653. that used in the machine doing the compilation.
  654.    Because different representation systems may offer different amounts
  655. of range and precision, the cross compiler cannot safely use the host
  656. machine's floating point arithmetic.  Therefore, floating point
  657. constants must be represented in the target machine's format.  This
  658. means that the cross compiler cannot use `atof' to parse a floating
  659. point constant; it must have its own special routine to use instead.
  660. Also, constant folding must emulate the target machine's arithmetic (or
  661. must not be done at all).
  662.    The macros in the following table should be defined only if you are
  663. cross compiling between different floating point formats.
  664.    Otherwise, don't define them.  Then default definitions will be set
  665. up which use `double' as the data type, `==' to test for equality, etc.
  666.    You don't need to worry about how many times you use an operand of
  667. any of these macros.  The compiler never uses operands which have side
  668. effects.
  669. `REAL_VALUE_TYPE'
  670.      A macro for the C data type to be used to hold a floating point
  671.      value in the target machine's format.  Typically this would be a
  672.      `struct' containing an array of `int'.
  673. `REAL_VALUES_EQUAL (X, Y)'
  674.      A macro for a C expression which compares for equality the two
  675.      values, X and Y, both of type `REAL_VALUE_TYPE'.
  676. `REAL_VALUES_LESS (X, Y)'
  677.      A macro for a C expression which tests whether X is less than Y,
  678.      both values being of type `REAL_VALUE_TYPE' and interpreted as
  679.      floating point numbers in the target machine's representation.
  680. `REAL_VALUE_LDEXP (X, SCALE)'
  681.      A macro for a C expression which performs the standard library
  682.      function `ldexp', but using the target machine's floating point
  683.      representation.  Both X and the value of the expression have type
  684.      `REAL_VALUE_TYPE'.  The second argument, SCALE, is an integer.
  685. `REAL_VALUE_FIX (X)'
  686.      A macro whose definition is a C expression to convert the
  687.      target-machine floating point value X to a signed integer.  X has
  688.      type `REAL_VALUE_TYPE'.
  689. `REAL_VALUE_UNSIGNED_FIX (X)'
  690.      A macro whose definition is a C expression to convert the
  691.      target-machine floating point value X to an unsigned integer.  X
  692.      has type `REAL_VALUE_TYPE'.
  693. `REAL_VALUE_RNDZINT (X)'
  694.      A macro whose definition is a C expression to round the
  695.      target-machine floating point value X towards zero to an integer
  696.      value (but still as a floating point number).  X has type
  697.      `REAL_VALUE_TYPE', and so does the value.
  698. `REAL_VALUE_UNSIGNED_RNDZINT (X)'
  699.      A macro whose definition is a C expression to round the
  700.      target-machine floating point value X towards zero to an unsigned
  701.      integer value (but still represented as a floating point number).
  702.      x has type `REAL_VALUE_TYPE', and so does the value.
  703. `REAL_VALUE_ATOF (STRING, MODE)'
  704.      A macro for a C expression which converts STRING, an expression of
  705.      type `char *', into a floating point number in the target machine's
  706.      representation for mode MODE.  The value has type
  707.      `REAL_VALUE_TYPE'.
  708. `REAL_INFINITY'
  709.      Define this macro if infinity is a possible floating point value,
  710.      and therefore division by 0 is legitimate.
  711. `REAL_VALUE_ISINF (X)'
  712.      A macro for a C expression which determines whether X, a floating
  713.      point value, is infinity.  The value has type `int'.  By default,
  714.      this is defined to call `isinf'.
  715. `REAL_VALUE_ISNAN (X)'
  716.      A macro for a C expression which determines whether X, a floating
  717.      point value, is a "nan" (not-a-number).  The value has type `int'.
  718.      By default, this is defined to call `isnan'.
  719.    Define the following additional macros if you want to make floating
  720. point constant folding work while cross compiling.  If you don't define
  721. them, cross compilation is still possible, but constant folding will
  722. not happen for floating point values.
  723. `REAL_ARITHMETIC (OUTPUT, CODE, X, Y)'
  724.      A macro for a C statement which calculates an arithmetic operation
  725.      of the two floating point values X and Y, both of type
  726.      `REAL_VALUE_TYPE' in the target machine's representation, to
  727.      produce a result of the same type and representation which is
  728.      stored in OUTPUT (which will be a variable).
  729.      The operation to be performed is specified by CODE, a tree code
  730.      which will always be one of the following: `PLUS_EXPR',
  731.      `MINUS_EXPR', `MULT_EXPR', `RDIV_EXPR', `MAX_EXPR', `MIN_EXPR'.
  732.      The expansion of this macro is responsible for checking for
  733.      overflow.  If overflow happens, the macro expansion should execute
  734.      the statement `return 0;', which indicates the inability to
  735.      perform the arithmetic operation requested.
  736. `REAL_VALUE_NEGATE (X)'
  737.      A macro for a C expression which returns the negative of the
  738.      floating point value X.  Both X and the value of the expression
  739.      have type `REAL_VALUE_TYPE' and are in the target machine's
  740.      floating point representation.
  741.      There is no way for this macro to report overflow, since overflow
  742.      can't happen in the negation operation.
  743. `REAL_VALUE_TRUNCATE (MODE, X)'
  744.      A macro for a C expression which converts the floating point value
  745.      X to mode MODE.
  746.      Both X and the value of the expression are in the target machine's
  747.      floating point representation and have type `REAL_VALUE_TYPE'.
  748.      However, the value should have an appropriate bit pattern to be
  749.      output properly as a floating constant whose precision accords
  750.      with mode MODE.
  751.      There is no way for this macro to report overflow.
  752. `REAL_VALUE_TO_INT (LOW, HIGH, X)'
  753.      A macro for a C expression which converts a floating point value X
  754.      into a double-precision integer which is then stored into LOW and
  755.      HIGH, two variables of type INT.
  756. `REAL_VALUE_FROM_INT (X, LOW, HIGH)'
  757.      A macro for a C expression which converts a double-precision
  758.      integer found in LOW and HIGH, two variables of type INT, into a
  759.      floating point value which is then stored into X.
  760.